home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / text / misc / ht.lha / hypertext / Dme / Readme < prev    next >
Text File  |  1990-12-23  |  6KB  |  117 lines
  1. \format
  2.     This file contains information on the macros for use with the text editor
  3. \BOLD DME \BOLD (by Matthew Dillon).  They essentially make DME an HT friendly
  4. editor (read it will be much easier to create HT documents).  This file
  5. assumes that you are somewhat familiar with DME and how it works.  If you
  6. are not familiar with DME, you may wish to use the setup that is on this
  7. disk (as DME is the default editor on disk).
  8.  
  9. \freeformat
  10.     Here's what there is:
  11.  
  12.  \ITALIC setup.edrc \ITALIC : This is the main file and contains the
  13.           keymappings/macros that make the other macros useable.
  14.           It sets up a couple of macros to handle text style changes
  15.           and also to do links (but you need the Arexx macros for them
  16.           to be useful).  It will also add a menu to your titlebar for
  17.           some easy access to the same functions.
  18.  
  19.  \ITALIC ht.dme \ITALIC     : This (short) ARexx/DME macro will allow you to quickly test
  20.           out any file you are currently working on.  It will save your
  21.           current file, then get HT running (if it isn't), and then
  22.           instruct HT to load the current file.
  23.  
  24.  \ITALIC link.dme \ITALIC   : This rather complicated macro will open a window with gadgets
  25.           for you to fill in and specify the kind of link you would
  26.           like at the current spot in the text.  It makes specifying
  27.           links *quite* a bit easier.  You can also preview your link
  28.           before inserting it.
  29.  
  30.  
  31. \center
  32. \bold Installing the DME macros\bold
  33.  
  34. \format
  35.     To make use of these macro packages, you have to do two things.  First
  36. copy the '.dme' files in the Rexx directory on this disk to your REXX:
  37. directory.  You will also want to copy the S:.edrc file to where you put
  38. your own .edrc file.  If you already have a specific DME setup, you may
  39. wish to edit the .edrc file to make it part of your setup.  Then simply
  40. fire up \BOLD DME \BOLD and source the \ITALIC setup.edrc \ITALIC file. You
  41. will then have an extra menu and several keymaps added to your \BOLD DME
  42. \BOLD enviroment. The menu items simply duplicate what the keymaps do.
  43.  
  44.  
  45. \freeformat
  46. NOTE:  When you start the ARexx macros for linking or testing the current
  47.        document, your title bar in DME will flash a lot with various
  48.        messages.  Try to ignore this as it is simply an artifact of the
  49.        REXX interface to DME, everything should proceed normally.
  50.  
  51. NOTE 2 : The first time you run each of these macros, there will tend to
  52.      be a fair amount of disk activity.  This is because several of the
  53.      macros require certain rexx libraries to be present.  Loading them
  54.      does require some time, but does only happen once.
  55.  
  56.  
  57. \center
  58. \underline So how do i use the macros once I've set them up? \underline
  59.  
  60. \format
  61.     I have setup macros to insert bolding, italicizing, and underling
  62. codes.    These save you the hassle of typing in \\BOLD all the time.  These
  63. macros are all \UNDERLINE Alt-key\UNDERLINE  based.  To make text italic,
  64. simply press \BOLD Alt-i \BOLD    (for italic).  Similarly for \BOLD bolded
  65. \bold text you press \BOLD Alt-b.\BOLD     To get underlined text you would
  66. press \BOLD Alt-u. \BOLD   These functions are also available via the
  67. 'HyperText' menu at the top of the screen.
  68.  
  69.     There is also a macro to let you test out your current file.  The \BOLD
  70. test \BOLD feature will save your current file to disk, and tell HT to load
  71. that file.  This is very convienent for quickly testing out HT-based
  72. documents as you are writing them.  All you have to do is press \BOLD Alt-t
  73. \BOLD (for "test") or choose "Test Current Document" from the Hypertext
  74. menu.  Doing that, causes HT to load and display your file.  This will let
  75. you see if everything is working properly with your document.
  76.  
  77.  
  78. \center
  79. \bold The "Link" Macro\bold
  80.  
  81.     The final macro is probably the most useful.  It allows you to easily
  82. specify link information.  All you are required to do is simply define the
  83. starting and ending positions of the link, and click your way through a
  84. small requestor.  This macro requires that you have RexxArpLib.library and
  85. screenshare.library in your libs: directory (in addition to arp.library
  86. which should already be there).
  87.  
  88.     To start defining a link you press Alt-s (for start), then type your
  89. text as you normally would.  Unfortunately the text will not be in inverse
  90. video because DME does not allow this.    When you have finished typing the
  91. text you wish to link, simply press Alt-l (for link).  This will execute
  92. an Arexx macro which pops up a requestor to be filled in.  When you close
  93. the requestor, the appropriate link information is then inserted directly
  94. into your document and you can keep typing.
  95.  
  96.     The requestor contains gadgets for specifying the type of link, and a
  97. string gadget (field) for the specific information.  If you forget a
  98. file name, you can also get a file requestor by clicking on the "File List"
  99. gadget.  This will open up an Arp file requestor from which you can select
  100. any file.  The file name you select (if any) will be inserted into the link
  101. requestor as needed.  In addition, you can preview your link by clicking
  102. the "Preview" gadget.  This will simulate what would happen if a user were
  103. to follow what you have currently defined as a link.   This is useful to
  104. verify that a link will work as you expect.
  105.  
  106.  
  107.     If after the requestor has popped up, you decide that you don't want
  108. to do this link, simply click the close gadget or if the string gadget is
  109. empty, simply hit return in it and it will go away.  That about covers it
  110. for the linking macro.
  111.  
  112.  
  113.     That pretty much covers the DME macros.  You should now be able to get
  114. started with DME and HT.  This is a good combo, and is what I used to
  115. create all of the HT documentation.
  116.  
  117.